Skip to content

fix(typescript): add Date instance check before date formatting #21722

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 5 commits into from
Aug 12, 2025
Merged

fix(typescript): add Date instance check before date formatting #21722

merged 5 commits into from
Aug 12, 2025

Conversation

0x5457
Copy link
Contributor

@0x5457 0x5457 commented Aug 9, 2025 •
edited
Loading

fixes kubernetes-client/javascript#2189

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples: 
    ./mvnw clean package || exit
./bin/generate-samples.sh ./bin/configs/*.yaml || exit
./bin/utils/export_docs_generators.sh || exit
    (For Windows users, please run the script in WSL)
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • File the PR against the correct branch: master (upcoming 7.x.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR solves a reported issue, reference it using GitHub's linking syntax (e.g., having "fixes #123" present in the PR description)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@TiFu (2017/07) @taxpon (2017/07) @sebastianhaas (2017/07) @kenisteward (2017/07) @Vrolijkx (2017/09) @macjohnny (2018/01) @topce (2018/10) @akehir (2019/07) @petejohansonxo (2019/11) @amakhrov (2020/02) @davidgamero (2022/03) @mkusaka (2022/04) @joscha (2024/10)

@0x5457 0x5457 changed the title Fix/typescript date formatting guard fix(typescript): add Date instance check before date formatting Aug 9, 2025
macjohnny
macjohnny approved these changes Aug 11, 2025
View reviewed changes
Copy link
Member

@macjohnny macjohnny left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks for the fix!

@macjohnny
Copy link
Member

macjohnny commented Aug 11, 2025 •
edited
Loading

@0x5457 can you make sure the samples are up-to-date and the CI passes? please merge in the latest master before re-generating the samples. then we can merge it

@0x5457 0x5457 requested a review from macjohnny August 11, 2025 15:13
@0x5457
Copy link
Contributor Author

0x5457 commented Aug 11, 2025 •
edited
Loading

Previously, typeScript couldn't properly infer that data was a Date instance, so the type inference was incorrect. When the type check(instanceof Date) was added, TypeScript correctly deduced that data must be a Date instance after passing the instanceof Date check, which meant: month and day variables are correctly typed as number.

https://github.com/OpenAPITools/openapi-generator/pull/21722/files#diff-8108788c164fdacafb0100b71bfe497ead20ad38a8190d58e03e31c089ea9d04R185-R189

use separate string variables for the formatted values to fix. @macjohnny

@macjohnny
Copy link
Member

macjohnny commented Aug 12, 2025 •
edited
Loading

@0x5457 the samples-up-to-date check still fails, can you take a look? i think its outdsted samples in the master branch, so can you just merge the most recent master and regenerate/commit all changed samples? that should fix it

@0x5457
Copy link
Contributor Author

0x5457 commented Aug 12, 2025

@0x5457 the samples-up-to-date check still fails, can you take a look?

@macjohnny It seems that this is an issue with C# (C-Sharp). I noticed that the master branch has the same problem.

@macjohnny
Copy link
Member

yeah can you regenerate the c# examples?

@0x5457 0x5457 force-pushed the fix/typescript-date-formatting-guard branch from 80fcccf to d289393 Compare August 12, 2025 09:17
@0x5457 0x5457 requested a review from macjohnny August 12, 2025 09:23
@macjohnny macjohnny merged commit 3e032bf into OpenAPITools:master Aug 12, 2025
15 checks passed
@0x5457 0x5457 mentioned this pull request Aug 13, 2025
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@macjohnny macjohnny Awaiting requested review from macjohnny

Assignees
No one assigned
Labels
Client: TypeScript
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Type Error. ObjectSerializer expects a date but I want to pass it a string
2 participants
@0x5457 @macjohnny